org.springframework.http.client

Class HttpComponentsClientHttpRequestFactory

java.lang.Object

org.springframework.http.client.HttpComponentsClientHttpRequestFactory

All Implemented Interfaces:

DisposableBean, ClientHttpRequestFactory

Direct Known Subclasses:

HttpComponentsAsyncClientHttpRequestFactory

public class HttpComponentsClientHttpRequestFactory
extends java.lang.Object
implements ClientHttpRequestFactory, DisposableBean

ClientHttpRequestFactory implementation that uses Apache HttpComponents HttpClient to create requests.

Allows to use a pre-configured HttpClient instance - potentially with authentication, HTTP connection pooling, etc.

NOTE: Requires Apache HttpComponents 4.3 or higher, as of Spring 4.0.

Since:

3.1

Author:

Oleg Kalnichevski, Arjen Poutsma, Stephane Nicoll

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	HttpComponentsClientHttpRequestFactory.HttpDelete An alternative to org.apache.http.client.methods.HttpDelete that extends org.apache.http.client.methods.HttpEntityEnclosingRequestBase rather than org.apache.http.client.methods.HttpRequestBase and hence allows HTTP delete with a request body.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	bufferRequestBody
private HttpClient	httpClient
private RequestConfig	requestConfig

Constructor Summary

Constructors

Constructor and Description
HttpComponentsClientHttpRequestFactory() Create a new instance of the HttpComponentsClientHttpRequestFactory with a default HttpClient.
HttpComponentsClientHttpRequestFactory(HttpClient httpClient) Create a new instance of the HttpComponentsClientHttpRequestFactory with the given HttpClient instance.

Method Summary

Modifier and Type	Method and Description
private RequestConfig.Builder	cloneRequestConfig()
protected HttpContext	createHttpContext(HttpMethod httpMethod, java.net.URI uri) Template methods that creates a HttpContext for the given HTTP method and URI.
protected HttpUriRequest	createHttpUriRequest(HttpMethod httpMethod, java.net.URI uri) Create a Commons HttpMethodBase object for the given HTTP method and URI specification.
ClientHttpRequest	createRequest(java.net.URI uri, HttpMethod httpMethod) Create a new ClientHttpRequest for the specified URI and HTTP method.
protected RequestConfig	createRequestConfig(HttpClient client) Create a default RequestConfig to use with the given client.
void	destroy() Shutdown hook that closes the underlying ClientConnectionManager's connection pool, if any.
HttpClient	getHttpClient() Return the HttpClient used for synchronous execution.
protected RequestConfig	getInternalRequestConfig()
protected RequestConfig	mergeRequestConfig(RequestConfig defaultRequestConfig)
protected void	postProcessHttpRequest(HttpUriRequest request) Template method that allows for manipulating the HttpUriRequest before it is returned as part of a HttpComponentsClientHttpRequest.
void	setBufferRequestBody(boolean bufferRequestBody) Indicates whether this request factory should buffer the request body internally.
void	setConnectionRequestTimeout(int connectionRequestTimeout) Set the timeout in milliseconds used when requesting a connection from the connection manager using the underlying HttpClient.
void	setConnectTimeout(int timeout) Set the connection timeout for the underlying HttpClient.
void	setHttpClient(HttpClient httpClient) Set the HttpClient used for synchronous execution.
private void	setLegacyConnectionTimeout(HttpClient client, int timeout) Apply the specified connection timeout to deprecated HttpClient implementations.
private void	setLegacySocketTimeout(HttpClient client, int timeout) Apply the specified socket timeout to deprecated HttpClient implementations.
void	setReadTimeout(int timeout) Set the socket read timeout for the underlying HttpClient.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

httpClient

private HttpClient httpClient

requestConfig

private RequestConfig requestConfig

bufferRequestBody

private boolean bufferRequestBody

Constructor Detail

HttpComponentsClientHttpRequestFactory

public HttpComponentsClientHttpRequestFactory()

Create a new instance of the HttpComponentsClientHttpRequestFactory with a default HttpClient.

HttpComponentsClientHttpRequestFactory

public HttpComponentsClientHttpRequestFactory(HttpClient httpClient)

Create a new instance of the HttpComponentsClientHttpRequestFactory with the given HttpClient instance.

Parameters:

httpClient - the HttpClient instance to use for this request factory

Method Detail

setHttpClient

public void setHttpClient(HttpClient httpClient)

Set the HttpClient used for synchronous execution.

getHttpClient

public HttpClient getHttpClient()

Return the HttpClient used for synchronous execution.

setConnectTimeout

public void setConnectTimeout(int timeout)

Set the connection timeout for the underlying HttpClient. A timeout value of 0 specifies an infinite timeout.

Additional properties can be configured by specifying a RequestConfig instance on a custom HttpClient.

Parameters:

timeout - the timeout value in milliseconds

See Also:

RequestConfig#getConnectTimeout()

setLegacyConnectionTimeout

private void setLegacyConnectionTimeout(HttpClient client,
                                        int timeout)

Apply the specified connection timeout to deprecated HttpClient implementations.

As of HttpClient 4.3, default parameters have to be exposed through a RequestConfig instance instead of setting the parameters on the client. Unfortunately, this behavior is not backward-compatible and older HttpClient implementations will ignore the RequestConfig object set in the context.

If the specified client is an older implementation, we set the custom connection timeout through the deprecated API. Otherwise, we just return as it is set through RequestConfig with newer clients.

Parameters:

client - the client to configure

timeout - the custom connection timeout

setConnectionRequestTimeout

public void setConnectionRequestTimeout(int connectionRequestTimeout)

Set the timeout in milliseconds used when requesting a connection from the connection manager using the underlying HttpClient. A timeout value of 0 specifies an infinite timeout.

Additional properties can be configured by specifying a RequestConfig instance on a custom HttpClient.

Parameters:

connectionRequestTimeout - the timeout value to request a connection in milliseconds

See Also:

RequestConfig#getConnectionRequestTimeout()

setReadTimeout

public void setReadTimeout(int timeout)

Set the socket read timeout for the underlying HttpClient. A timeout value of 0 specifies an infinite timeout.

Additional properties can be configured by specifying a RequestConfig instance on a custom HttpClient.

Parameters:

timeout - the timeout value in milliseconds

See Also:

RequestConfig#getSocketTimeout()

setLegacySocketTimeout

private void setLegacySocketTimeout(HttpClient client,
                                    int timeout)

Apply the specified socket timeout to deprecated HttpClient implementations. See setLegacyConnectionTimeout(HttpClient, int).

Parameters:

client - the client to configure

timeout - the custom socket timeout

See Also:

setLegacyConnectionTimeout(HttpClient, int)

cloneRequestConfig

private RequestConfig.Builder cloneRequestConfig()

setBufferRequestBody

public void setBufferRequestBody(boolean bufferRequestBody)

Indicates whether this request factory should buffer the request body internally.

Default is true. When sending large amounts of data via POST or PUT, it is recommended to change this property to false, so as not to run out of memory.

createRequest

public ClientHttpRequest createRequest(java.net.URI uri,
                                       HttpMethod httpMethod)
                                throws java.io.IOException

Description copied from interface: ClientHttpRequestFactory

Create a new ClientHttpRequest for the specified URI and HTTP method.

The returned request can be written to, and then executed by calling ClientHttpRequest.execute().

Specified by:

createRequest in interface ClientHttpRequestFactory

Parameters:

uri - the URI to create a request for

httpMethod - the HTTP method to execute

Returns:

the created request

Throws:

java.io.IOException - in case of I/O errors

createRequestConfig

protected RequestConfig createRequestConfig(HttpClient client)

Create a default RequestConfig to use with the given client. Can return null to indicate that no custom request config should be set and the defaults of the HttpClient should be used.

The default implementation tries to merge the defaults of the client with the local customizations of this instance, if any.

Parameters:

client - the client

Returns:

the RequestConfig to use

Since:

4.2

mergeRequestConfig

protected RequestConfig mergeRequestConfig(RequestConfig defaultRequestConfig)

getInternalRequestConfig

protected final RequestConfig getInternalRequestConfig()

createHttpUriRequest

protected HttpUriRequest createHttpUriRequest(HttpMethod httpMethod,
                                              java.net.URI uri)

Create a Commons HttpMethodBase object for the given HTTP method and URI specification.

Parameters:

httpMethod - the HTTP method

uri - the URI

Returns:

the Commons HttpMethodBase object

postProcessHttpRequest

protected void postProcessHttpRequest(HttpUriRequest request)

Template method that allows for manipulating the HttpUriRequest before it is returned as part of a HttpComponentsClientHttpRequest.

The default implementation is empty.

Parameters:

request - the request to process

createHttpContext

protected HttpContext createHttpContext(HttpMethod httpMethod,
                                        java.net.URI uri)

Template methods that creates a HttpContext for the given HTTP method and URI.

The default implementation returns null.

Parameters:

httpMethod - the HTTP method

uri - the URI

Returns:

the http context

destroy

public void destroy()
             throws java.lang.Exception

Shutdown hook that closes the underlying ClientConnectionManager's connection pool, if any.

Specified by:

destroy in interface DisposableBean

Throws:

java.lang.Exception - in case of shutdown errors. Exceptions will get logged but not rethrown to allow other beans to release their resources too.